Resource URL: /platform/<<version=3>>/event/alert-conditions/<ID>

    Overview: This resource applies the standard collection pattern to
              individual alert conditions.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve the alert-condition.

       URL: GET /platform/<<version=3>>/event/alert-conditions/<ID>

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "alert-conditions": {
      "items": {
        "type": "object", 
        "description": "Specifies under what conditions and over which channel an alert should be sent", 
        "properties": {
          "name": {
            "type": "string", 
            "description": "Unique identifier."
          }, 
          "channel_ids": {
            "items": {
              "type": "integer"
            }, 
            "type": "array", 
            "description": "Channels for alert"
          }, 
          "interval": {
            "type": "integer", 
            "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions"
          }, 
          "eventgroup_ids": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Event Group IDs to be alerted"
          }, 
          "severities": {
            "items": {
              "enum": [
                "emergency", 
                "critical", 
                "warning", 
                "information"
              ], 
              "type": "string"
            }, 
            "type": "array", 
            "description": "Severities to be alerted"
          }, 
          "transient": {
            "type": "integer", 
            "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition."
          }, 
          "limit": {
            "type": "integer", 
            "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added"
          }, 
          "categories": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Event Group categories to be alerted"
          }, 
          "id": {
            "type": "string", 
            "description": "Unique identifier."
          }, 
          "condition": {
            "enum": [
              "NEW", 
              "NEW EVENTS", 
              "ONGOING", 
              "SEVERITY INCREASE", 
              "SEVERITY DECREASE", 
              "RESOLVED"
            ], 
            "type": "string", 
            "description": "Trigger condition for alert"
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method PUT: Modify the alert-condition

       URL: PUT /platform/<<version=3>>/event/alert-conditions/<ID>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies under what conditions and over which channel an alert should be sent", 
  "properties": {
    "channel_ids": {
      "items": {
        "type": "integer"
      }, 
      "type": "array", 
      "description": "Channels for alert"
    }, 
    "interval": {
      "type": "integer", 
      "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions"
    }, 
    "eventgroup_ids": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Event Group IDs to be alerted"
    }, 
    "severities": {
      "items": {
        "enum": [
          "emergency", 
          "critical", 
          "warning", 
          "information"
        ], 
        "type": "string"
      }, 
      "type": "array", 
      "description": "Severities to be alerted"
    }, 
    "transient": {
      "type": "integer", 
      "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition."
    }, 
    "limit": {
      "type": "integer", 
      "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added"
    }, 
    "categories": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Event Group categories to be alerted"
    }, 
    "condition": {
      "enum": [
        "NEW", 
        "NEW EVENTS", 
        "ONGOING", 
        "SEVERITY INCREASE", 
        "SEVERITY DECREASE", 
        "RESOLVED"
      ], 
      "type": "string", 
      "description": "Trigger condition for alert"
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete the alert-condition.

          URL: DELETE /platform/<<version=3>>/event/alert-conditions/<ID>

There are no query arguments for this method.

There is no response body for this method.
